home *** CD-ROM | disk | FTP | other *** search
/ SGI Freeware 1999 August / SGI Freeware 1999 August.iso / dist / fw_emacs.idb / usr / freeware / share / emacs / 19.34 / lisp / picture.el.z / picture.el
Encoding:
Text File  |  1998-10-28  |  25.5 KB  |  647 lines
  1. ;;; picture.el --- "Picture mode" -- editing using quarter-plane screen model.
  2.  
  3. ;; Copyright (C) 1985, 1994 Free Software Foundation, Inc.
  4.  
  5. ;; Author: K. Shane Hartman
  6. ;; Maintainer: FSF
  7.  
  8. ;; This file is part of GNU Emacs.
  9.  
  10. ;; GNU Emacs is free software; you can redistribute it and/or modify
  11. ;; it under the terms of the GNU General Public License as published by
  12. ;; the Free Software Foundation; either version 2, or (at your option)
  13. ;; any later version.
  14.  
  15. ;; GNU Emacs is distributed in the hope that it will be useful,
  16. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  17. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18. ;; GNU General Public License for more details.
  19.  
  20. ;; You should have received a copy of the GNU General Public License
  21. ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  22. ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  23. ;; Boston, MA 02111-1307, USA.
  24.  
  25. ;;; Commentary:
  26.  
  27. ;; This code provides the picture-mode commands documented in the Emacs 
  28. ;; manual.  The screen is treated as a semi-infinite quarter-plane with
  29. ;; support for rectangle operations and `etch-a-sketch' character
  30. ;; insertion in any of eight directions.
  31.  
  32. ;;; Code:
  33.  
  34. (defun move-to-column-force (column)
  35.   "Move to column COLUMN in current line.
  36. Differs from `move-to-column' in that it creates or modifies whitespace
  37. if necessary to attain exactly the specified column."
  38.   (or (natnump column) (setq column 0))
  39.   (move-to-column column)
  40.   (let ((col (current-column)))
  41.     (if (< col column)
  42.     (indent-to column)
  43.       (if (and (/= col column)
  44.            (= (preceding-char) ?\t))
  45.       (let (indent-tabs-mode)
  46.         (delete-char -1)
  47.             (indent-to col)
  48.             (move-to-column column))))
  49.     ;; This call will go away when Emacs gets real horizontal autoscrolling
  50.     (hscroll-point-visible)))
  51.  
  52.  
  53. ;; Picture Movement Commands
  54.  
  55. (defun picture-beginning-of-line (&optional arg)
  56.   "Position point at the beginning of the line.
  57. With ARG not nil, move forward ARG - 1 lines first.
  58. If scan reaches end of buffer, stop there without error."
  59.   (interactive "P")
  60.   (if arg (forward-line (1- (prefix-numeric-value arg))))
  61.   (beginning-of-line)
  62.   ;; This call will go away when Emacs gets real horizontal autoscrolling
  63.   (hscroll-point-visible))
  64.  
  65. (defun picture-end-of-line (&optional arg)
  66.   "Position point after last non-blank character on current line.
  67. With ARG not nil, move forward ARG - 1 lines first.
  68. If scan reaches end of buffer, stop there without error."
  69.   (interactive "P")
  70.   (if arg (forward-line (1- (prefix-numeric-value arg))))
  71.   (beginning-of-line)
  72.   (skip-chars-backward " \t" (prog1 (point) (end-of-line)))
  73.   ;; This call will go away when Emacs gets real horizontal autoscrolling
  74.   (hscroll-point-visible))
  75.  
  76. (defun picture-forward-column (arg)
  77.   "Move cursor right, making whitespace if necessary.
  78. With argument, move that many columns."
  79.   (interactive "p")
  80.   (let ((target-column (+ (current-column) arg)))
  81.     (move-to-column-force target-column)
  82.     ;; Picture mode isn't really suited to multi-column characters,
  83.     ;; but we might as well let the user move across them.
  84.     (and (< arg 0)
  85.      (> (current-column) target-column)
  86.      (forward-char -1))))
  87.  
  88. (defun picture-backward-column (arg)
  89.   "Move cursor left, making whitespace if necessary.
  90. With argument, move that many columns."
  91.   (interactive "p")
  92.   (picture-forward-column (- arg)))
  93.  
  94. (defun picture-move-down (arg)
  95.   "Move vertically down, making whitespace if necessary.
  96. With argument, move that many lines."
  97.   (interactive "p")
  98.   (let ((col (current-column)))
  99.     (picture-newline arg)
  100.     (move-to-column-force col)))
  101.  
  102. (defconst picture-vertical-step 0
  103.   "Amount to move vertically after text character in Picture mode.")
  104.  
  105. (defconst picture-horizontal-step 1
  106.   "Amount to move horizontally after text character in Picture mode.")
  107.  
  108. (defun picture-move-up (arg)
  109.   "Move vertically up, making whitespace if necessary.
  110. With argument, move that many lines."
  111.   (interactive "p")
  112.   (picture-move-down (- arg)))
  113.  
  114. (defun picture-movement-right ()
  115.   "Move right after self-inserting character in Picture mode."
  116.   (interactive)
  117.   (picture-set-motion 0 1))
  118.  
  119. (defun picture-movement-left ()
  120.   "Move left after self-inserting character in Picture mode."
  121.   (interactive)
  122.   (picture-set-motion 0 -1))
  123.  
  124. (defun picture-movement-up ()
  125.   "Move up after self-inserting character in Picture mode."
  126.   (interactive)
  127.   (picture-set-motion -1 0))
  128.  
  129. (defun picture-movement-down ()
  130.   "Move down after self-inserting character in Picture mode."
  131.   (interactive)
  132.   (picture-set-motion 1 0))
  133.  
  134. (defun picture-movement-nw ()
  135.   "Move up and left after self-inserting character in Picture mode."
  136.   (interactive)
  137.   (picture-set-motion -1 -1))
  138.  
  139. (defun picture-movement-ne ()
  140.   "Move up and right after self-inserting character in Picture mode."
  141.   (interactive)
  142.   (picture-set-motion -1 1))
  143.  
  144. (defun picture-movement-sw ()
  145.   "Move down and left after self-inserting character in Picture mode."
  146.   (interactive)
  147.   (picture-set-motion 1 -1))
  148.  
  149. (defun picture-movement-se ()
  150.   "Move down and right after self-inserting character in Picture mode."
  151.   (interactive)
  152.   (picture-set-motion 1 1))
  153.  
  154. (defun picture-set-motion (vert horiz)
  155.   "Set VERTICAL and HORIZONTAL increments for movement in Picture mode.
  156. The mode line is updated to reflect the current direction."
  157.   (setq picture-vertical-step vert
  158.     picture-horizontal-step horiz)
  159.   (setq mode-name
  160.     (format "Picture:%s"
  161.         (car (nthcdr (+ 1 (% horiz 2) (* 3 (1+ (% vert 2))))
  162.                  '(nw up ne left none right sw down se)))))
  163.   (force-mode-line-update)
  164.   (message ""))
  165.  
  166. (defun picture-move ()
  167.   "Move in direction of `picture-vertical-step' and `picture-horizontal-step'."
  168.   (picture-move-down picture-vertical-step)
  169.   (picture-forward-column picture-horizontal-step))
  170.  
  171. (defun picture-motion (arg)
  172.   "Move point in direction of current picture motion in Picture mode.
  173. With ARG do it that many times.  Useful for delineating rectangles in
  174. conjunction with diagonal picture motion.
  175. Do \\[command-apropos]  picture-movement  to see commands which control motion."
  176.   (interactive "p")
  177.   (picture-move-down (* arg picture-vertical-step))
  178.   (picture-forward-column (* arg picture-horizontal-step)))
  179.  
  180. (defun picture-motion-reverse (arg)
  181.   "Move point in direction opposite of current picture motion in Picture mode.
  182. With ARG do it that many times.  Useful for delineating rectangles in
  183. conjunction with diagonal picture motion.
  184. Do \\[command-apropos] `picture-movement' to see commands which control motion."
  185.   (interactive "p")
  186.   (picture-motion (- arg)))
  187.  
  188.  
  189. ;; Picture insertion and deletion.
  190.  
  191. (defun picture-self-insert (arg)
  192.   "Insert this character in place of character previously at the cursor.
  193. The cursor then moves in the direction you previously specified
  194. with the commands `picture-movement-right', `picture-movement-up', etc.
  195. Do \\[command-apropos] `picture-movement' to see those commands."
  196.   (interactive "p")
  197.   (while (> arg 0)
  198.     (setq arg (1- arg))
  199.     (move-to-column-force (1+ (current-column)))
  200.     (delete-char -1)
  201.     (insert last-command-event)        ; Always a character in this case.
  202.     (forward-char -1)
  203.     (picture-move)))
  204.  
  205. (defun picture-clear-column (arg)
  206.   "Clear out ARG columns after point without moving."
  207.   (interactive "p")
  208.   (let* ((opoint (point))
  209.      (original-col (current-column))
  210.      (target-col (+ original-col arg)))
  211.     (move-to-column-force target-col)
  212.     (delete-region opoint (point))
  213.     (save-excursion
  214.      (indent-to (max target-col original-col)))))
  215.  
  216. (defun picture-backward-clear-column (arg)
  217.   "Clear out ARG columns before point, moving back over them."
  218.   (interactive "p")
  219.   (picture-clear-column (- arg)))
  220.  
  221. (defun picture-clear-line (arg)
  222.   "Clear out rest of line; if at end of line, advance to next line.
  223. Cleared-out line text goes into the kill ring, as do newlines that are
  224. advanced over.  With argument, clear out (and save in kill ring) that
  225. many lines."
  226.   (interactive "P")
  227.   (if arg
  228.       (progn
  229.        (setq arg (prefix-numeric-value arg))
  230.        (kill-line arg)
  231.        (newline (if (> arg 0) arg (- arg))))
  232.     (if (looking-at "[ \t]*$")
  233.     (kill-ring-save (point) (progn (forward-line 1) (point)))
  234.       (kill-region (point) (progn (end-of-line) (point))))))
  235.  
  236. (defun picture-newline (arg)
  237.   "Move to the beginning of the following line.
  238. With argument, moves that many lines (up, if negative argument);
  239. always moves to the beginning of a line."
  240.   (interactive "p")
  241.   (if (< arg 0)
  242.       (forward-line arg)
  243.     (while (> arg 0)
  244.       (end-of-line)
  245.       (if (eobp) (newline) (forward-char 1))
  246.       (setq arg (1- arg))))
  247.   ;; This call will go away when Emacs gets real horizontal autoscrolling
  248.   (hscroll-point-visible))
  249.  
  250. (defun picture-open-line (arg)
  251.   "Insert an empty line after the current line.
  252. With positive argument insert that many lines."
  253.   (interactive "p")
  254.   (save-excursion
  255.    (end-of-line)
  256.    (open-line arg))
  257.   ;; This call will go away when Emacs gets real horizontal autoscrolling
  258.   (hscroll-point-visible))
  259.  
  260. (defun picture-duplicate-line ()
  261.   "Insert a duplicate of the current line, below it."
  262.   (interactive)
  263.   (save-excursion
  264.    (let ((contents
  265.       (buffer-substring
  266.        (progn (beginning-of-line) (point))
  267.        (progn (picture-newline 1) (point)))))
  268.      (forward-line -1)
  269.      (insert contents))))
  270.  
  271. ;; Like replace-match, but overwrites.
  272. (defun picture-replace-match (newtext fixedcase literal)
  273.   (let (ocolumn change pos)
  274.     (goto-char (setq pos (match-end 0)))
  275.     (setq ocolumn (current-column))
  276.     ;; Make the replacement and undo it, to see how it changes the length.
  277.     (let ((buffer-undo-list nil)
  278.       list1)
  279.       (replace-match newtext fixedcase literal)
  280.       (setq change (- (current-column) ocolumn))
  281.       (setq list1 buffer-undo-list)
  282.       (while list1
  283.     (setq list1 (primitive-undo 1 list1))))
  284.     (goto-char pos)
  285.     (if (> change 0)
  286.     (delete-region (point)
  287.                (progn
  288.              (move-to-column-force (+ change (current-column)))
  289.              (point))))
  290.     (replace-match newtext fixedcase literal)
  291.     (if (< change 0)
  292.     (insert-char ?\ (- change)))))
  293.  
  294. ;; Picture Tabs
  295.  
  296. (defvar picture-tab-chars "!-~"
  297.   "*A character set which controls behavior of commands
  298. \\[picture-set-tab-stops] and \\[picture-tab-search].  It is NOT a
  299. regular expression, any regexp special characters will be quoted.
  300. It defines a set of \"interesting characters\" to look for when setting
  301. \(or searching for) tab stops, initially \"!-~\" (all printing characters).
  302. For example, suppose that you are editing a table which is formatted thus:
  303. | foo        | bar + baz | 23  *
  304. | bubbles    | and + etc | 97  *
  305. and that `picture-tab-chars' is \"|+*\".  Then invoking
  306. \\[picture-set-tab-stops] on either of the previous lines would result
  307. in the following tab stops
  308.         :     :     :     :
  309. Another example - \"A-Za-z0-9\" would produce the tab stops
  310.   :          :    :     :
  311.  
  312. Note that if you want the character `-' to be in the set, it must be
  313. included in a range or else appear in a context where it cannot be
  314. taken for indicating a range (e.g. \"-A-Z\" declares the set to be the
  315. letters `A' through `Z' and the character `-').  If you want the
  316. character `\\' in the set it must be preceded by itself: \"\\\\\".
  317.  
  318. The command \\[picture-tab-search] is defined to move beneath (or to) a
  319. character belonging to this set independent of the tab stops list.")
  320.  
  321. (defun picture-set-tab-stops (&optional arg)
  322.   "Set value of `tab-stop-list' according to context of this line.
  323. This controls the behavior of \\[picture-tab].  A tab stop is set at
  324. every column occupied by an \"interesting character\" that is preceded
  325. by whitespace.  Interesting characters are defined by the variable
  326. `picture-tab-chars', see its documentation for an example of usage.
  327. With ARG, just (re)set `tab-stop-list' to its default value.  The tab
  328. stops computed are displayed in the minibuffer with `:' at each stop."
  329.   (interactive "P")
  330.   (save-excursion
  331.     (let (tabs)
  332.       (if arg
  333.       (setq tabs (default-value 'tab-stop-list))
  334.     (let ((regexp (concat "[ \t]+[" (regexp-quote picture-tab-chars) "]")))
  335.       (beginning-of-line)
  336.       (let ((bol (point)))
  337.         (end-of-line)
  338.         (while (re-search-backward regexp bol t)
  339.           (skip-chars-forward " \t")
  340.           (setq tabs (cons (current-column) tabs)))
  341.         (if (null tabs)
  342.         (error "No characters in set %s on this line."
  343.                (regexp-quote picture-tab-chars))))))
  344.       (setq tab-stop-list tabs)
  345.       (let ((blurb (make-string (1+ (nth (1- (length tabs)) tabs)) ?\ )))
  346.     (while tabs
  347.       (aset blurb (car tabs) ?:)
  348.       (setq tabs (cdr tabs)))
  349.     (message blurb)))))
  350.  
  351. (defun picture-tab-search (&optional arg)
  352.   "Move to column beneath next interesting char in previous line.
  353. With ARG move to column occupied by next interesting character in this
  354. line.  The character must be preceded by whitespace.
  355. \"interesting characters\" are defined by variable `picture-tab-chars'.
  356. If no such character is found, move to beginning of line."
  357.   (interactive "P")
  358.   (let ((target (current-column)))
  359.     (save-excursion
  360.       (if (and (not arg)
  361.            (progn
  362.          (beginning-of-line)
  363.          (skip-chars-backward
  364.           (concat "^" (regexp-quote picture-tab-chars))
  365.           (point-min))
  366.          (not (bobp))))
  367.       (move-to-column target))
  368.       (if (re-search-forward
  369.        (concat "[ \t]+[" (regexp-quote picture-tab-chars) "]")
  370.        (save-excursion (end-of-line) (point))
  371.        'move)
  372.       (setq target (1- (current-column)))
  373.     (setq target nil)))
  374.     (if target
  375.     (move-to-column-force target)
  376.       (beginning-of-line))))
  377.  
  378. (defun picture-tab (&optional arg)
  379.   "Tab transparently (just move point) to next tab stop.
  380. With prefix arg, overwrite the traversed text with spaces.  The tab stop
  381. list can be changed by \\[picture-set-tab-stops] and \\[edit-tab-stops].
  382. See also documentation for variable `picture-tab-chars'."
  383.   (interactive "P")
  384.   (let* ((opoint (point)))
  385.     (move-to-tab-stop)
  386.     (if arg
  387.     (let (indent-tabs-mode
  388.           (column (current-column)))
  389.       (delete-region opoint (point))
  390.       (indent-to column)))))
  391.  
  392. ;; Picture Rectangles
  393.  
  394. (defconst picture-killed-rectangle nil
  395.   "Rectangle killed or copied by \\[picture-clear-rectangle] in Picture mode.
  396. The contents can be retrieved by \\[picture-yank-rectangle]")
  397.  
  398. (defun picture-clear-rectangle (start end &optional killp)
  399.   "Clear and save rectangle delineated by point and mark.
  400. The rectangle is saved for yanking by \\[picture-yank-rectangle] and replaced
  401. with whitespace.  The previously saved rectangle, if any, is lost.  With
  402. prefix argument, the rectangle is actually killed, shifting remaining text."
  403.   (interactive "r\nP")
  404.   (setq picture-killed-rectangle (picture-snarf-rectangle start end killp)))
  405.  
  406. (defun picture-clear-rectangle-to-register (start end register &optional killp)
  407.   "Clear rectangle delineated by point and mark into REGISTER.
  408. The rectangle is saved in REGISTER and replaced with whitespace.  With
  409. prefix argument, the rectangle is actually killed, shifting remaining text."
  410.   (interactive "r\ncRectangle to register: \nP")
  411.   (set-register register (picture-snarf-rectangle start end killp)))
  412.  
  413. (defun picture-snarf-rectangle (start end &optional killp)
  414.   (let ((column (current-column))
  415.     (indent-tabs-mode nil))
  416.     (prog1 (save-excursion
  417.              (if killp
  418.                  (delete-extract-rectangle start end)
  419.                (prog1 (extract-rectangle start end)
  420.                       (clear-rectangle start end))))
  421.        (move-to-column-force column))))
  422.  
  423. (defun picture-yank-rectangle (&optional insertp)
  424.   "Overlay rectangle saved by \\[picture-clear-rectangle]
  425. The rectangle is positioned with upper left corner at point, overwriting
  426. existing text.  With prefix argument, the rectangle is inserted instead,
  427. shifting existing text.  Leaves mark at one corner of rectangle and
  428. point at the other (diagonally opposed) corner."
  429.   (interactive "P")
  430.   (if (not (consp picture-killed-rectangle))
  431.       (error "No rectangle saved.")
  432.     (picture-insert-rectangle picture-killed-rectangle insertp)))
  433.  
  434. (defun picture-yank-at-click (click arg)
  435.   "Insert the last killed rectangle at the position clicked on.
  436. Also move point to one end of the text thus inserted (normally the end).
  437. Prefix arguments are interpreted as with \\[yank].
  438. If `mouse-yank-at-point' is non-nil, insert at point
  439. regardless of where you click."
  440.   (interactive "e\nP")
  441.   (or mouse-yank-at-point (mouse-set-point click))
  442.   (picture-yank-rectangle arg))
  443.  
  444. (defun picture-yank-rectangle-from-register (register &optional insertp)
  445.   "Overlay rectangle saved in REGISTER.
  446. The rectangle is positioned with upper left corner at point, overwriting
  447. existing text.  With prefix argument, the rectangle is
  448. inserted instead, shifting existing text.  Leaves mark at one corner
  449. of rectangle and point at the other (diagonally opposed) corner."
  450.   (interactive "cRectangle from register: \nP")
  451.   (let ((rectangle (get-register register)))
  452.     (if (not (consp rectangle))
  453.     (error "Register %c does not contain a rectangle." register)
  454.       (picture-insert-rectangle rectangle insertp))))
  455.  
  456. (defun picture-insert-rectangle (rectangle &optional insertp)
  457.   "Overlay RECTANGLE with upper left corner at point.
  458. Optional argument INSERTP, if non-nil causes RECTANGLE to be inserted.
  459. Leaves the region surrounding the rectangle."
  460.   (let ((indent-tabs-mode nil))
  461.     (if (not insertp)
  462.     (save-excursion
  463.       (delete-rectangle (point)
  464.                 (progn
  465.                   (picture-forward-column (length (car rectangle)))
  466.                   (picture-move-down (1- (length rectangle)))
  467.                   (point)))))
  468.     (push-mark)
  469.     (insert-rectangle rectangle)))
  470.  
  471.  
  472. ;; Picture Keymap, entry and exit points.
  473.  
  474. (defconst picture-mode-map nil)
  475.  
  476. (defun picture-substitute (oldfun newfun)
  477.   (substitute-key-definition oldfun newfun picture-mode-map global-map))
  478.  
  479. (if (not picture-mode-map)
  480.     (progn
  481.       (setq picture-mode-map (list 'keymap (make-vector 256 nil)))
  482.       (picture-substitute 'self-insert-command 'picture-self-insert)
  483.       (picture-substitute 'completion-separator-self-insert-command
  484.               'picture-self-insert)
  485.       (picture-substitute 'completion-separator-self-insert-autofilling
  486.               'picture-self-insert)
  487.       (picture-substitute 'forward-char 'picture-forward-column)
  488.       (picture-substitute 'backward-char 'picture-backward-column)
  489.       (picture-substitute 'delete-char 'picture-clear-column)
  490.       ;; There are two possibilities for what is normally on DEL.
  491.       (picture-substitute 'backward-delete-char-untabify 'picture-backward-clear-column)
  492.       (picture-substitute 'delete-backward-char 'picture-backward-clear-column)
  493.       (picture-substitute 'kill-line 'picture-clear-line)
  494.       (picture-substitute 'open-line 'picture-open-line)
  495.       (picture-substitute 'newline 'picture-newline)
  496.       (picture-substitute 'newline-and-indent 'picture-duplicate-line)
  497.       (picture-substitute 'next-line 'picture-move-down)
  498.       (picture-substitute 'previous-line 'picture-move-up)
  499.       (picture-substitute 'beginning-of-line 'picture-beginning-of-line)
  500.       (picture-substitute 'end-of-line 'picture-end-of-line)
  501.  
  502.       (define-key picture-mode-map "\C-c\C-d" 'delete-char)
  503.       (define-key picture-mode-map "\e\t" 'picture-toggle-tab-state)
  504.       (define-key picture-mode-map "\t" 'picture-tab)
  505.       (define-key picture-mode-map "\e\t" 'picture-tab-search)
  506.       (define-key picture-mode-map "\C-c\t" 'picture-set-tab-stops)
  507.       (define-key picture-mode-map "\C-c\C-k" 'picture-clear-rectangle)
  508.       (define-key picture-mode-map "\C-c\C-w" 'picture-clear-rectangle-to-register)
  509.       (define-key picture-mode-map "\C-c\C-y" 'picture-yank-rectangle)
  510.       (define-key picture-mode-map "\C-c\C-x" 'picture-yank-rectangle-from-register)
  511.       (define-key picture-mode-map "\C-c\C-c" 'picture-mode-exit)
  512.       (define-key picture-mode-map "\C-c\C-f" 'picture-motion)
  513.       (define-key picture-mode-map "\C-c\C-b" 'picture-motion-reverse)
  514.       (define-key picture-mode-map "\C-c<" 'picture-movement-left)
  515.       (define-key picture-mode-map "\C-c>" 'picture-movement-right)
  516.       (define-key picture-mode-map "\C-c^" 'picture-movement-up)
  517.       (define-key picture-mode-map "\C-c." 'picture-movement-down)
  518.       (define-key picture-mode-map "\C-c`" 'picture-movement-nw)
  519.       (define-key picture-mode-map "\C-c'" 'picture-movement-ne)
  520.       (define-key picture-mode-map "\C-c/" 'picture-movement-sw)
  521.       (define-key picture-mode-map "\C-c\\" 'picture-movement-se)))
  522.  
  523. (defvar picture-mode-hook nil
  524.   "If non-nil, its value is called on entry to Picture mode.
  525. Picture mode is invoked by the command \\[picture-mode].")
  526.  
  527. (defvar picture-mode-old-local-map)
  528. (defvar picture-mode-old-mode-name)
  529. (defvar picture-mode-old-major-mode)
  530. (defvar picture-mode-old-truncate-lines)
  531.  
  532. ;;;###autoload
  533. (defun picture-mode ()
  534.   "Switch to Picture mode, in which a quarter-plane screen model is used.
  535. Printing characters replace instead of inserting themselves with motion
  536. afterwards settable by these commands:
  537.   C-c <      Move left after insertion.
  538.   C-c >      Move right after insertion.
  539.   C-c ^      Move up after insertion.
  540.   C-c .      Move down after insertion.
  541.   C-c `      Move northwest (nw) after insertion.
  542.   C-c '      Move northeast (ne) after insertion.
  543.   C-c /      Move southwest (sw) after insertion.
  544.   C-c \\   Move southeast (se) after insertion.
  545. The current direction is displayed in the mode line.  The initial
  546. direction is right.  Whitespace is inserted and tabs are changed to
  547. spaces when required by movement.  You can move around in the buffer
  548. with these commands:
  549.   \\[picture-move-down]      Move vertically to SAME column in previous line.
  550.   \\[picture-move-up]      Move vertically to SAME column in next line.
  551.   \\[picture-end-of-line]      Move to column following last non-whitespace character.
  552.   \\[picture-forward-column]      Move right inserting spaces if required.
  553.   \\[picture-backward-column]      Move left changing tabs to spaces if required.
  554.   C-c C-f Move in direction of current picture motion.
  555.   C-c C-b Move in opposite direction of current picture motion.
  556.   Return  Move to beginning of next line.
  557. You can edit tabular text with these commands:
  558.   M-Tab      Move to column beneath (or at) next interesting character.
  559.         `Indents' relative to a previous line.
  560.   Tab      Move to next stop in tab stop list.
  561.   C-c Tab Set tab stops according to context of this line.
  562.         With ARG resets tab stops to default (global) value.
  563.         See also documentation of variable    picture-tab-chars
  564.         which defines \"interesting character\".  You can manually
  565.         change the tab stop list with command \\[edit-tab-stops].
  566. You can manipulate text with these commands:
  567.   C-d      Clear (replace) ARG columns after point without moving.
  568.   C-c C-d Delete char at point - the command normally assigned to C-d.
  569.   \\[picture-backward-clear-column]  Clear (replace) ARG columns before point, moving back over them.
  570.   \\[picture-clear-line]      Clear ARG lines, advancing over them.     The cleared
  571.         text is saved in the kill ring.
  572.   \\[picture-open-line]      Open blank line(s) beneath current line.
  573. You can manipulate rectangles with these commands:
  574.   C-c C-k Clear (or kill) a rectangle and save it.
  575.   C-c C-w Like C-c C-k except rectangle is saved in named register.
  576.   C-c C-y Overlay (or insert) currently saved rectangle at point.
  577.   C-c C-x Like C-c C-y except rectangle is taken from named register.
  578.   \\[copy-rectangle-to-register]   Copies a rectangle to a register.
  579.   \\[advertised-undo]   Can undo effects of rectangle overlay commands
  580.         commands if invoked soon enough.
  581. You can return to the previous mode with:
  582.   C-c C-c Which also strips trailing whitespace from every line.
  583.         Stripping is suppressed by supplying an argument.
  584.  
  585. Entry to this mode calls the value of  picture-mode-hook  if non-nil.
  586.  
  587. Note that Picture mode commands will work outside of Picture mode, but
  588. they are not defaultly assigned to keys."
  589.   (interactive)
  590.   (if (eq major-mode 'picture-mode)
  591.       (error "You are already editing a picture.")
  592.     (make-local-variable 'picture-mode-old-local-map)
  593.     (setq picture-mode-old-local-map (current-local-map))
  594.     (use-local-map picture-mode-map)
  595.     (make-local-variable 'picture-mode-old-mode-name)
  596.     (setq picture-mode-old-mode-name mode-name)
  597.     (make-local-variable 'picture-mode-old-major-mode)
  598.     (setq picture-mode-old-major-mode major-mode)
  599.     (setq major-mode 'picture-mode)
  600.     (make-local-variable 'picture-killed-rectangle)
  601.     (setq picture-killed-rectangle nil)
  602.     (make-local-variable 'tab-stop-list)
  603.     (setq tab-stop-list (default-value 'tab-stop-list))
  604.     (make-local-variable 'picture-tab-chars)
  605.     (setq picture-tab-chars (default-value 'picture-tab-chars))
  606.     (make-local-variable 'picture-vertical-step)
  607.     (make-local-variable 'picture-horizontal-step)
  608.     (make-local-variable 'picture-mode-old-truncate-lines)
  609.     (setq picture-mode-old-truncate-lines truncate-lines)
  610.     (setq truncate-lines t)
  611.     (picture-set-motion 0 1)
  612.  
  613.     ;; edit-picture-hook is what we used to run, picture-mode-hook is in doc.
  614.     (run-hooks 'edit-picture-hook 'picture-mode-hook)
  615.     (message "Type %s in this buffer to return it to %s mode."
  616.          (substitute-command-keys "\\[picture-mode-exit]")
  617.          picture-mode-old-mode-name)))
  618.  
  619. ;;;###autoload
  620. (defalias 'edit-picture 'picture-mode)
  621.  
  622. (defun picture-mode-exit (&optional nostrip)
  623.   "Undo picture-mode and return to previous major mode.
  624. With no argument strips whitespace from end of every line in Picture buffer
  625.   otherwise just return to previous mode."
  626.   (interactive "P")
  627.   (if (not (eq major-mode 'picture-mode))
  628.       (error "You aren't editing a Picture.")
  629.     (if (not nostrip) (picture-clean))
  630.     (setq mode-name picture-mode-old-mode-name)
  631.     (use-local-map picture-mode-old-local-map)
  632.     (setq major-mode picture-mode-old-major-mode)
  633.     (kill-local-variable 'tab-stop-list)
  634.     (setq truncate-lines picture-mode-old-truncate-lines)
  635.     (force-mode-line-update)))
  636.  
  637. (defun picture-clean ()
  638.   "Eliminate whitespace at ends of lines."
  639.   (save-excursion
  640.    (goto-char (point-min))
  641.    (while (re-search-forward "[ \t][ \t]*$" nil t)
  642.      (delete-region (match-beginning 0) (point)))))
  643.  
  644. (provide 'picture)
  645.  
  646. ;;; picture.el ends here
  647.